int cdecl far allocmem(unsigned size, unsigned far *segp);
Returns -1 for successful allocation. Can allocate up to 64K. Up to 64 segments can be allocated at one time by ALL of the WinDosIO applications combined.
void cdecl far arc(int x, int y, int stangle, int endangle, int radius);
Draws a circular arc in the current color, from start angle to end angle, with the given radius, centered at x,y.
Returns: Nothing
Errors: grNoInitGraph, grMSParameter
_ARC
short cdecl far _arc(short x1, short y1, short x2, short y2, short svx, short svy, short evx , short evy);
Draws the arc bounded by the bounding box x1, y1, x2, y2 and centered at the boxes center. The second point of the start vector is svx and svy. The second point of the end vector is evx, evy.
Returns: TRUE (non zero) if successful and FALSE otherwise.
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
BAR
void cdecl far bar(int left, int top, int right, int bottom);
Draws a filled in rectangle in the current fillstyle and fillcolor, bounded by left, top, right and bottom. The rectangles border is in the same color as the fill. See setfillstyle.
Returns: Nothing
Errors: grNoInitGraph, grMSParameter
BAR3D
void cdecl far bar3d(int left, int top, int right, int bottom, int depth,int topflag);
Draws a three dimensional rectangle and fills it with the current fill pattern and color. The bars depth in pixels is given by depth. Topflag governs whether there is a three dimensional top on the bars. Leaving off the top allows bars to stack.
Returns: Nothing
Errors: grNoInitGraph, grMSParameter
BDOS
int cdecl far bdos(int dosfun, unsigned dosdx, unsigned dosal);
Although this function is not disabled under Windows, the following sub functions are intercepted by WinDosIO. Sub functions (dosfun = 1,2,6,7,8,11) are handled by WinDosIO. Other functions call the standard bdos().
Returns: The value of the AX register.
Subfunction:
1 - The return code from getche()
2 - The passed dosal argument
6 - The return from getch() or dosal, depending on dosdx
7 - The return from getch()
8 - The return from getch()
11 - The return from kbhit()
Errors: None
BDOSPTR
int cdecl far bdosptr(int dosfun, void far *argument, unsigned dosal);
Although this function is not disabled under Windows, the following sub functions are intercepted by WinDosIO. Sub functions (dosfun = 9,10) are handled by WinDosIO. Other functions call the standard bdosptr().
Returns: The value of the AX register.
Subfunction:
9 - Value of dosal
10 - Value of dosal
Errors: None
BIOSKEY
int cdecl far bioskey(int cmd);
Sub functions 0,1 and 2 are intercepted by WinDosIO.
Returns: Subfunction:
0 - The high and low byte returned by 1 or 2 getch()'s
1 - The return from kbhit()
2 - The flag modifiers
-1 - Incorrect sub function
Errors: None
BRK
int cdecl far brk(void far *);
This function performs no service and is present only for code compatibility.
Returns: 0
Errors: None
CGETS
char far * cdecl far cgets(char far *s)
Reads a string from the termIO window with the focus. s[0] contains the maximum length of the string. On return s[1] contains number of characters read. Actual string returned begins at s[2]. CR/LF replaced with null terminator before storing the string.
Draws a circle in the current color, with the center at x,y using the specified radius. The current line thickness is used, but not the line style.
Returns: Nothing
Errors: grNoInitGraph
CLEARDEVICE
void cdecl far cleardevice(void);
Erases the entire termIO window with the current background color. The current position for lines and text is moved to 0,0.
Returns: Nothing
Errors: grNoInitGraph
CLEARERR
void cdecl far clearerr(FILE far *stream);
If stdin, stdout or stderr is redirected, this function clears the error or EOF indicators of the redirected files. For other streams, the run-time clearerr() is called.
Returns: Nothing
Errors: None
_CLEARSCREEN
void cdecl far _clearscreen(short area);
If area is _GCLEARSCREEN, the entire termIO window is cleared with the current background color. If area is _GVIEWPORT, only the current viewport is cleared. If the area is _GWINDOW, only the current text window is cleared.
Returns: Nothing
Errors: _GRNOTINPROPERMODE,_GRINVALIDPARAMETER
CLEARVIEWPORT
void cdecl far clearviewport(void);
Erases the viewport and moves the current position to 0,0 of the viewport.
Returns: Nothing
Errors: grNoInitGraph
CLOSEGRAPH
void cdecl far closegraph(void);
This function does nothing and is included only for compatibility.
Returns: Nothing
Errors: grNoInitGraph
CLREOL
void cdecl far clreol(void);
Clears all characters from the cursor position to the end of the line within the current text window.
Returns the amount of memory available to Windows. Note the 'long' return in this function, as opposed to the Borland equivalent.
Returns: Memory available to Windows.
Errors: None
CPRINTF
int cdecl far cprintf(const char far *formatString,...)
Displays the resultant formatted string in the termIO window with the focus. See one of the many C texts available for a description of the control codes allowed. All Pointers in the format string must be cast or declared as far *, if not compiling with the large or compact model.
Returns: The number of characters output or EOF on error
int cdecl far cscanf(const char far *formatString,...);
Reads directly from the termIO window, and formats each field according to a format specifier. The formatted input is stored at the addresses passed as subsequent arguments. All pointers in the formatString must be declared or cast as far *, if not compiling with the large or compact model.
Returns: The number of input fields successfully scanned.
The program is suspended for at least the specified number of milliseconds. Control is returned to Windows. If another application gains control, the delay can be considerably longer.
Returns: Nothing
Errors: None
DELLINE
void cdecl far delline(void);
Deletes the line containing the cursor and moves all lines below it and within the current window, up one line.
void cdecl far drawpoly(int numpoints, int far *polypoints);
Draws a polygon with numpoints points, using the current line style and color. Polypoints points to an array of numpoints 'struct pointtype's, or a sequence of numpoints * 2 integers. Each pair of integers gives the x and y coordinates of a point on the polygon.
Returns: Nothing
Errors: grNoInitGraph
ELLIPSE
void cdecl far ellipse(int x, int y, int stangle, int endangle, int xradius, int yradius);
Draws an elliptical arc, in the current drawing color, from start angle to end angle, with the specified xradius and yradius and centered at x,y. The ellipse is not filled in.
Returns: Nothing
Errors: grNoInitGraph
_ELLIPSE
short cdecl far _ellipse(short control, short x1, short y1, short x2, short y2);
The center of the ellipse is the center of the bounding rectangle [x1,y1,x2,y2]. If control is _GFILLINTERIOR, the ellipse is filled with the current color(different than fillellipse()) and current fillstyle. If control is _GBORDER, only the border will be drawn in the current color, with the current line thickness. To effect the fill color, the Microsoft style _setcolor routine must be called, rather than the Borland style setcolor routine.
Returns: Returns TRUE if the drawing is successful, otherwise FALSE.
Errors: _GRNOTINPROPERMODE,_GRINVALIDPARAMETER
FCLOSE
int cdecl far fclose(FILE far *stream);
If stdin, stdout or stderr is redirected, and this function is called with one of those streams, the redirected file is closed. If the stream is not redirected, this function does nothing, and if called with another stream, the run time fclose() is called.
Returns: 0 on success, EOF if any other errors detected.
Errors: Errno and C++ close errors
FEOF
int cdecl far feof(FILE far *stream);
Feof is not a macro, but a function. If stdin is redirected, and this function is called with that stream, the EOF indicator of the redirected file is returned. If stdin is not redirected, the function returns 0 and if called with another stream, the run time feof() is called.
Returns: 0 on if EOF not reached, otherwise non-zero.
Errors: Errno
FERROR
int cdecl far ferror(FILE far *stream);
Ferror is not a macro, but a function. If stdin, stdout or stderr is redirected, and this function is called with one of those streams, an error on the stream will cause a non-zero value to be is returned. If the stream is not redirected, this function returns 0, and if called with another stream, the run time ferror() is called.
Returns: 0 if no errors on the stream, and non-zero otherwise
Errors: Errno and C++ .bad errors
FFLUSH
int cdecl far fflush(FILE far *stream);
If stdout or stderr is redirected, and this function is called with one of those streams, all buffered output will be written to the redirected file. If the stream is not redirected, this function returns 0, and if called with another stream, the run time fflush() is called.
Returns: 0 on success and EOF if any other errors detected.
Errors: Errno and C++ flush errors
FGETC
int cdecl far fgetc(FILE far *stream);
If stdin is redirected and this function is called from that stream, it will return the next character of redirected input. If not redirected, this will return the next character from the keyboard. For other streams, the run time fgetc() will be called.
Returns: On success, returns the character read, otherwise returns EOF for end of file or errors.
Errors: Errno or C++ read.
FGETS
char far * cdecl far fgets(char far *s, int n, FILE far *stream);
If stdin is redirected and this function is called from that stream, it will return the next character string from redirected input. If not redirected, this will return the next character string from the keyboard. For other streams, the run time fgets() will be called. The string is placed in buffer s, for a length of n. Length is ignored on stdin.
Returns: On success, returns a pointer to the string gotten or NULL on end of file or error.
Errors: Errno or C++ read.
FILLELLIPSE
void cdecl far fillellipse(int x, int y, int xradius, int yradius);
Draws an ellipse using x,y as the center and xradius and yradius as the two axis. The ellipse is filled in with the current fill color and fill pattern.
Returns: Nothing
Errors: grNoInitGraph
FILLPOLY
void cdecl far fillpoly(int numpoints, int far *polypoints);
Draws the outline of a polygon with numpoints 'struct pointtype's pointed to by polypoints in the current linestyle, thickness and color. The polygon is then filled using the current fill pattern and fill color.
Returns: Nothing
Errors: grNoInitGraph
FLOODFILL
void cdecl far floodfill(int x, int y, int border);
Fills an enclosed area, starting at x,y in all directions with the current fill pattern and fill color, until it is blocked in all directions with pixels of the color 'border'.
Returns: Nothing
Errors: grNoInitGraph
_FLOODFILL
short cdecl far _floodfill(short x, short y, short boundary);
Fills an enclosed area, starting at x,y in all directions with the current fill pattern and current color, until it is blocked in all directions with pixels of the color 'border'.
Returns: TRUE if fill is successful and FALSE otherwise.
Errors: grNoInitGraph
FLUSHALL
int cdecl far flushall(void);
If stdin is redirected, input is cleared. If stdout or stderr are redirected, output is flushed. The run-time flushall is then called to handle other open files.
Returns: Count of open files, including redirected stdin, stdout and stderr.
Errors: None.
FOPEN
FILE far * cdecl far fopen(const char far *filename, const char far *mode);
If called with a filename of "con" and a mode of 'r', stdin is returned. Otherwise, if called with a filename of "con", stdout is opened. Any other filename while return the run-time fopen().
Returns: Returns a pointer to the newly open stream or NULL in the event of error.
Errors: Errno or C++ open.
FPRINTF
int cdecl far fprintf(FILE far *stream, const char far *format, ...);
If the argument stream is stdout or stderr, a normal printf is done to those streams. This is true regardless of whether the output is redirected. For other streams, the run-time fprintf will be called.
Returns: The number of bytes output, or EOF on error.
Errors: Errno or WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_OUT_OF_MEMORY, WDE_DISK_ERROR.
FPUTC
int cdecl far fputc(int c, FILE far *stream);
If the argument stream is stdout or stderr, a normal putch is done to those streams. This is true regardless of whether the output is redirected. For other streams, the run-time fputc will be called.
Returns: The character c or EOF on error.
Errors: Errno or WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_OUT_OF_MEMORY, WDE_DISK_ERROR.
FPUTS
int cdecl far fputs(const char far *s, FILE far *stream);
If the argument stream is stdout or stderr, a normal puts is done to those streams. This is true regardless of whether the output is redirected. For other streams, the run-time fputs will be called.
Returns: The last character written or EOF on error.
Errors: Errno or WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_OUT_OF_MEMORY, WDE_DISK_ERROR.
FREAD
size_t cdecl far fread(void far *ptr, size_t size, size_t n,FILE far *stream);
If the stream is stdin, characters are read from the keyboard or redirected stream, until size * n is reached or EOF is read. For other streams the run-time fread is returned.
Returns: The number of items(n) not bytes read. It returns 0 on EOF or error.
Errors: Errno or WDErrno Values: WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_DISK_ERROR
FREEMEM
int cdecl far freemem(unsigned segx);
Unlocks and returns to Windows the specified segment allocated with allocmem.
Returns: 0 if the segment is valid, -1 otherwise.
Errors: None
FSCANF
int cdecl far fscanf(FILE far *stream, const char far *format, ...);
Formats input according to the specification. For stdin, gets characters from the keyboard or redirected stream. All pointers in the format must be declared or cast as far *, if not compiling with the large or compact models.
Returns: The number of input fields scanned, converted and stored. At end of file, the return value is EOF. If no fields are stored, the return value is 0.
Errors: None
FWRITE
size_t cdecl far fwrite(const void far *ptr, size_t size, size_t n, FILE far *stream);
If the stream is stdout or stderr, n * size characters are written from ptr to the termIO window or redirected output. For other streams, the run-time fwrite() is called.
Returns: The number of items(n), not bytes, actually written.
Errors: Errno or WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_OUT_OF_MEMORY, WDE_DISK_ERROR.
GETARCCOORDS
void cdecl far getarccoords(struct arccoordstype far *arccoords);
Fills the structure with information about the last call to _arc, arc, ellipse, pie or _pie. The x and y fields indicate the center. The xstart, ystart, xend and yend are endpoints of the arc. The structure contains random data if there was no previous call to one of the above functions.
Returns: Nothing
Errors: grNoInitGraph
_GETARCINFO
short cdecl far _getarcinfo(struct xycoord far *start,struct xycoord far *end, struct xycoord far *fillpoint);
Fills the three xycoord structures with the start, end and center of the last call to _arc, arc, ellipse, pie or _pie. The structures contain random data if there was no previous call to one of the above functions.
Returns: TRUE if successful, FALSE otherwise.
Errors: _GRNOTINPROPERMODE
GETASPECTRATIO
void cdecl far getaspectratio(int far *xasp, int far *yasp);
This function sets the current aspect ratio in xasp and yasp. This is the aspect ratio returned by Windows.
Returns: Nothing
Errors: None
GETBKCOLOR
int cdecl far getbkcolor(void);
In this version due to hardware compatability only returns 0.
Errors: grNoInitGraph
_GETBKCOLOR
long cdecl far _getbkcolor(void);
Returns a long form of the color index 0-15 for the text and graphics background color.
Returns: The color index.
Errors: None
GETCH
int cdecl far getch(void)
Reads a character from the termIO window with the focus, without echoing the character.
Returns: The character read or EOF on error. If the character read is zero, it is an extended character. The next call to getch returns the following.
Gets a character from the termIO window with the focus, or from redirected standard input. Strange syntax errors usually indicate that <stdio.h> was included after <WinDosIO.h> causing the getchar macro to be redefined.
Returns: The last character read, without sign extension or EOF on error.
struct xycoord cdecl far _getcurrentposition(void);
Returns the coordinates of the current graphics position.
Returns: The current graphics position as the 4 byte struct xycoord.
Errors: None
GETDEFAULTPALETTE
struct palettetype far * cdecl far getdefaultpalette(void);
NOTE: Changing palettes has no effect in version 2.0
Returns: Pointer to the initial palette.
Errors: grNoInitGraph
GETDRIVERNAME
char far * cdecl far getdrivername(void);
Returns "Windows"
Returns: Pointer to the zero terminated string "Windows".
Errors: grNoInitGraph
_GETFILLMASK
unsigned char far * far cdecl _getfillmask(unsigned char far *);
Returns the 8 byte 8 * 8 fillmask, used by _floodfill and functions using _GFILLINTERIOR. It is returned in the address provided. This function fails if the Borland style function set the mask to one of the predefined fill patterns.
Returns: A pointer to the mask or NULL, if no mask is present.
Errors: _GRNOTINPROPERMODE
GETFILLPATTERN
void cdecl far getfillpattern(char far *pattern);
Sets the 8 * 8 fillmask, used by floodfill and the various fill functions into the address provided. The function returns random data, if no fill mask has been set.
Returns: Nothing
Errors: grNoInitGraph
GETFILLSETTINGS
void cdecl far getfillsettings(struct fillsettingstype far *fillInfo);
Returns the current fill pattern type and fill color. If the pattern type is USER_FILL, then getfillpattern() should be called.
Returns: Nothing
Errors: grNoInitGraph
_GETFONTINFO
short cdecl far _getfontinfo(struct _fontinfo far *buffer);
Returns in the _fontinfo structure whose address is provided, type(0=bitmap, 1=vector), ascent, pixwidth(0 for proportional), pixheight, avgwidth,facename and filename(always "Windows").
Returns: A non negative number means the call was successful.
Errors: _GRNOTINPROPERMODE
GETGRAPHMODE
int cdecl far getgraphmode(void);
This function performs no service and is present only for code compatibility.
Returns: 0 or -1 on error
Errors: grNoInitGraph
_GETGTEXTEXTENT
short cdecl far _getgtextextent(unsigned char far *text);
Returns the width in pixels of the character string in the current font and pointsize.
Returns: The width in pixels or -1 on error.
Errors: _GRNOTINPROPERMODE
_GETGTEXTVECTOR
struct xycoord cdecl far _getgtextvector(void);
Returns the direction of font rotation.(1,0) default horizontal,
(0,1) 90 degrees counter-clockwise, (-1,0) 180 degrees (0,-1) 90 degrees clockwise. Only vectored fonts can be rotated. An attempt to rotate a font which cannot be rotated will produce paint problems.
Returns: The structure, filled with (0,0) on error.
Errors: _GRNOTINPROPERMODE
Errors:
GETIMAGE
void cdecl far getimage(int left, int top, int right, int bottom,void far *bitmap);
Copies a bitmap image from the screen to memory 'bitmap'. To determine the size of bitmap, call imagesize() first. left,top,right and bottom define the screen area to be copied.
Returns: Nothing
Errors: grNoInitGraph , grMSParameter
_GETIMAGE
void cdecl far _getimage(short x1, short y1, short x2, short y2, char far *image);
Copies a bitmap image from the screen to memory 'bitmap'. To determine the size of bitmap, call imagesize() first. (x1,y1) (x2,y2) define the screen area to be copied. Unlike the Borland style function, the two points can come in either order.
Returns: Nothing
Errors: _GRNOTINPROPERMODE,_GRINVALIDPARAMETER
GETLINESETTINGS
void cdecl far getlinesettings(struct linesettingstype far *lineinfo);
Returns the current linestyle, upattern and thickness. upattern is a 2 byte pattern which is not used in this version of WinDosIO.
Returns: Nothing
Errors: grNoInitGraph
_GETLINESTYLE
unsigned short cdecl far _getlinestyle(void);
The return from this function is quite different than the return from the same named Microsoft style function. The value returned % 7 determines which of the built-in line types is being used. The return value >> 3 is the thickness of the line.
Returns: Integer line style described above or -1 on error.
Errors: _GRNOTINPROPERMODE
_GETLOGCOORD
struct xycoord cdecl far _getlogcoord(short x, short y);
Returns the logical coordinates(relative to the current viewport) of the point whose physical location is x,y. This function is identical to _getviewcoord, which is preferred.
Returns: The four byte structure with the logical coordinates.
Errors: _GRNOTINPROPERMODE
GETMAXCOLOR
int cdecl far getmaxcolor(void);
Returns the highest valid color value for the current graphics mode.(1, 3 or 15)
Returns: The color index or -1 on error.
Errors: grNoInitGraph
GETMAXMODE
int cdecl far getmaxmode(void);
This function performs no service and is present only for code compatibility.
Returns: 0 or -1 on error
Errors: grNoInitGraph
GETMAXX
int cdecl far getmaxx(void);
Returns the maximum x value for the termIO window. This is determined from the initial dimensions of the created window.
Returns: Maximum x value or grNoInitGraph.
Errors: grNoInitGraph
GETMAXY
int cdecl far getmaxy(void);
Returns the maximum y value for the termIO window. This is determined from the initial dimensions of the created window.
Returns: Maximum y value or grNoInitGraph.
Errors: grNoInitGraph
GETMODENAME
char far * cdecl far getmodename(int mode_number);
Returns "Windows"
Returns: Pointer to zero terminated message.
Errors: None
GETMODERANGE
void cdecl far getmoderange(int graphdriver, int far *lomode, int far *himode);
This function performs no service and is present only for code compatibility.
Returns: Nothing
Errors: grNoInitGraph
GETPALETTE
void cdecl far getpalette(struct palettetype far *palette);
Fills the structure provided with information about the current palettes size and colors. Only the default palette is returned in this version!
Returns: Nothing
Errors: grNoInitGraph
GETPALETTESIZE
int cdecl far getpalettesize(void);
Returns the number of colors.
Returns: The number of active colors.
Errors: grNoInitGraph
GETPASS
char far * cdecl far getpass(char far *s)
Reads a string of up to 8 characters from the termIO window with the focus. The characters will not be echoed to the termIO window. If more than 8 characters are entered, only the first 8 will be returned.
Returns: A pointer to static null terminated string which will be overwritten with next call or NULL on error.
struct xycoord cdecl far _getphyscoord(short x, short y);
Converts from logical or viewport coordinates into physical screen coordinates.
Returns: 4 byte structure containing the physical x and y coordinates.
Errors: _GRNOTINPROPERMODE
GETPIXEL
unsigned cdecl far getpixel(int x, int y);
Returns the pixel value of the pixel located at x,y.
Returns: Pixel value(0-15)
Errors: grNoInitGraph
_GETPIXEL
short cdecl far _getpixel(short x, short y);
Returns the pixel value of the pixel located at x,y.
Returns: Pixel value(0-15)
Errors: _GRNOTINPROPERMODE
GETS
char far * cdecl far gets(char far *s);
Reads a string from the termIO window with the focus, or from redirected standard input. It returns when it encounters a new line and converts the new line to a null terminator or when 256 characters have been entered.
Returns: A pointer to the null terminated string or NULL on error.
int cdecl far gettext(int left,int top, int right, int bottom, void far *dest);
Places the contents of the on screen text rectangle defined by left, top, bottom and right into the memory pointed to by dest. In the current implementation, text written to multiple pages will be merged by gettext().
Returns: 1 if operation succeeds and 0 if it fails.
Returns the value of the current text color used by all non-graphics text output routines.
Returns: The color index(0-15)
Errors: None
_GETTEXTCURSOR
short cdecl far _gettextcursor(void);
Returns a short representing the current text cursor. The return value is either _NOCURSOR, _NORMALCURSOR, _SOLIDCURSOR or _USERCURSOR. The cursor value can be restored with a call to _settextcursor, as long as the cursor is not _USERCURSOR. In that case, the top and bottom scan lines must also have been saved.
struct videoconfig far * far cdecl _getvideoconfig(struct videoconfig far *);
Returns in the structure provided, the number of x and y pixels, the number of text columns and rows, the number of colors, and number of memory pages.
Returns: A pointer to the structure provided.
Errors: grNoInitGraph
_GETVIEWCOORD
struct xycoord cdecl far _getviewcoord(short x, short y);
Translates physical screen coordinates to logical or view coordinates.
Sets viewport to entire screen, moves current position to 0,0, restores the palette to its default colors, restores background and foreground default colors and empty fill pattern.
Returns: Nothing
Errors: grNoInitGraph
GRAPHERRORMSG
char far * cdecl far grapherrormsg(int errorcode);
Returns the error message associated with the Borland style lower case gr... error codes.
Returns: Zero terminated message.
Errors: None
GRAPHRESULT
int cdecl far graphresult(void);
Returns the Borland style error code for the last graphics call which reported an error and restores the error level to grOK.
Returns: Error number
Errors: None.
_GRSTATUS
short cdecl far _grstatus(void);
Returns the Microsoft style error code for the last graphics call which reported an error and restores the error level to _GROK. This function differs from the Microsoft version which resets grstatus after every function call, even the successful ones.
Returns: Error code.
Errors: None.
HEAPCHECK
int cdecl far heapcheck(void);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
HEAPCHECKFREE
int cdecl far heapcheckfree(unsigned int);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
HEAPCHECKNODE
int cdecl far heapchecknode(void far *);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
HEAPFILLFREE
int cdecl far heapfillfree(unsigned int);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
HEAPWALK
int cdecl far heapwalk(void far *);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
HIGHVIDEO
void cdecl far highvideo(void);
Sets high intensity bit of current foreground character.
unsigned cdecl far imagesize(int left, int top, int right, int bottom);
Returns the amount of memory required to store the bitmap image of the rectangle described by left, top, right and bottom. If the size is greater than 65535 bytes, 0xffff is returned. See _IMAGESIZE below for rectangles whose space requirement is > 64K.
Returns: Number of bytes required
Errors: grNoInitGraph
_IMAGESIZE
long cdecl far _imagesize(short x1, short y1, short x2, short y2);
Returns the amount of memory required to store the bitmap image of the rectangle described by the points x1,y1 and x2,y2.
Returns: Long number of bytes required.
Errors: _GRNOTINPROPERMODE
INITGRAPH
void cdecl far initgraph(int far * graphdriver, int far * graphmode,char far *path);
This function performs no service and is present only for code compatibility.
Returns: Nothing
Errors: None
INSLINE
void cdecl far insline(void);
Inserts an empty line in the text window at the cursor position, scrolling the lines below the empty one, down a line.
int cdecl far installuserdriver(char far *, int huge (*)(void));
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
INSTALLUSERFONT
int cdecl far installuserfont(char *);
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
INT86
int cdecl far int86(int intno, union REGS far *inregs,union REGS far *outregs);
Intercepts the following video BIOS calls (0x10)
1 returns inregs->x.ax only
2 uses gotoxy
3 uses wherex and wherey to set up outregs
5 returns inregs->x.ax only
6 scrolls up the window
7 scrolls down the window
8 retrieves character at cursor
9 puts character cx times, changes attribute
a puts character cx times
b returns inregs->x.ax only
c putpixel
d getpixel
e put character
Other functions and sub functions are handled by the run-time int86. If you require the actual BIOS version of any of these sub-functions, use the Borland geninterrupt or call int86x on the above sub-functions.
Returns: inregs->x.ax
Errors: None
INTDOS
int cdecl far intdos( union REGS far *__inregs,union REGS far *__outregs );
Intercepts the following DOS calls(0x21)
1 uses getche
2 uses putch
6 uses putch and getch
7 uses getch
8 uses getch
b uses kbhit
The translation on some of these functions differs slightly from the actual DOS calls. Other functions and sub-functions are handled by the actual run-time intdos. If you require the actual DOS version of any of these sub-functions, use Borland's geninterrupt or int86x.
Returns: outregs->x.ax
Errors: doserrno
INTDOSX
int cdecl far intdosx( union REGS far *__inregs,union REGS far *__outregs,struct SREGS far *__segregs );
Intercepts the following DOS calls(0x21)
9 uses putch
a uses cgets
Other functions and sub-functions are handled by the actual run-time intdos. If you require the actual DOS version of any of these sub-functions, use Borland's geninterrupt or int86x.
Returns: outregs->x.ax
Errors: doserrno
KBHIT
int cdecl far kbhit(void);
Returns a non-zero value, if a keystroke is available. If not, zero is returned.
Returns: 255 if keystroke available, 0 if not available, -1 on error
void cdecl far line(int x1, int y1, int x2, int y2);
Draws a line in the current color, using current line style and thickness between points x1,y1 and x2,y2. The current position is not updated.
Returns: Nothing
Errors: grNoInitGraph
LINEREL
void cdecl far linerel(int dx, int dy);
Draws a line from the current position, in the current color, thickness and style to a point that is a relative distance dx,dy from the current position. The current position is updated by that relative distance.
Returns: Nothing
Errors: grNoInitGraph
LINETO
void cdecl far lineto(int x, int y);
Draws a line from the current position, in the current color, thickness and style to the point x,y. The current position is updated to x,y.
Returns: Nothing
Errors: grNoInitGraph
_LINETO
short cdecl far _lineto(short x, short y);
Draws a line from the current position, in the current color, thickness and style to the point x,y. The current position is updated to x,y.
Returns: TRUE if the line is drawn successfully, otherwise FALSE.
Errors: _GRNOTINPROPERMODE
LOWVIDEO
void cdecl far lowvideo(void);
Clears the high intensity bit of the currently selected foreground color for subsequent text output operations.
Moves the current position dx pixels in the x direction and dy pixels in the y direction.
Returns: Nothing
Errors: grNoInitGraph
MOVETEXT
int cdecl far movetext(int left, int top, int right, int bottom, int destleft, int desttop);
Copies the text defined by the rectangle left,top,right,bottom to the rectangle whose upper left corner is destleft, desttop. Rectangles that overlap are moved correctly.
Returns: Returns TRUE if the operation succeeded, FALSE otherwise
Displays the zero terminated text string, at the current position, using the current font, direction, size and alignment. If the alignment is LEFT_TEXT and the direction is HORIZ_DIR, the current position is advanced to the end of the string, otherwise, the current position does not change.
Returns: Nothing
Errors: grNoInitGraph
_OUTTEXT
void cdecl far _outtext(char far *textString);
Outputs textmode text, at the cursor position in the current text color. The cursor position is updated.
void cdecl far outtextxy(int x, int y, char far *textString);
Displays the zero terminated text string, at the position x,y, using the current font, direction, size and alignment. The current position is not affected.
Returns: Nothing
Errors: grNoInitGraph
PERROR
void cdecl far perror(const char far *s);
Prints the argument s, a colon then the message corresponding to the current value of errno to the stderr stream. This only works for errno set in the DLL.
Returns: Nothing
Errors: Errno or WDE_NO_CURRENT_WINDOW, WDE_USERQUIT, WDE_UNINITIALIZED, WDE_OUT_OF_MEMORY, WDE_DISK_ERROR.
_PIE
short cdecl far _pie(short cntrl, short x1, short y1, short x2, short y2, short xb, short yb,short xe, short ye);
Draws a pie shape in the bounding box (x1,y1) , (x2,y2), such that the pie begins where the ellipse intersects the line from the center of the bounding box to (xb,yb) and ends where the ellipse intersects the bounding box from the center of the bounding box to (xe, ye). If cntrl is _GFILLINTERIOR, the pie is filled in. _GFILLBORDER causes only the border to be drawn.
Returns: TRUE if successful, FALSE on error.
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
PIESLICE
void cdecl far pieslice(int x, int y, int stangle, int endangle, int radius);
Draws a filled pie slice with its center at (x,y). It begins at stangle in degrees and ends at endangle in degrees, with a radius of 'radius' pixels.
Returns: Nothing
Errors: grNoInitGraph
_POLYGON
short cdecl far _polygon(short cntrl, struct xycoord far *points, short num_pnts);
Draws a polygon, connecting num_pnts in the array of points provided. If cntrl is _GFILLINTERIOR, the polygon is filled in with the current color and fill mask. If cntrl is _GFILLBORDER, the polygon is not filled in.
Returns: TRUE, if anything is drawn, FALSE on error.
Errors: _GRNOTINPROPERMODE,_GRINVALIDPARAMETER
PRINTF
int cdecl far printf(const char far *formatString,...)
Displays the resultant formatted string in the termIO window with the focus or to redirected standard output. See one of the many C texts available for a description of the control codes allowed. All pointers in the formatString must be declared or cast as far *, if not compiling with the large or compact memory models.
Returns: The number of characters output or EOF on error
void cdecl far putimage(int left, int top, void far *bitmap, int op);
Puts the image 'bitmap', previously saved with getimage, to the screen at the left and top specified. op specifies a logical operator that controls how the pixels are combined with the background. Valid operators are COPY_PUT, XOR_PUT, etc. See WinDosIO.h.
Returns: Nothing
Errors: grNoInitGraph, grMSImage
_PUTIMAGE
void cdecl far _putimage(short left, short top, char far *bitmap, short action);
Puts the image 'bitmap', previously saved with getimage, to the screen at the left and top specified. action specifies a logical operator that controls how the pixels are combined with the background. Valid operators are _GAND,_GXOR, etc. See WinDosIO.h.
Returns: Nothing
Errors: _GRNOTINPROPERMODE, _GRINVALIDIMAGEBUFFER
PUTPIXEL
void cdecl far putpixel(int x, int y, int color);
Plots a point in the specified color index at (x,y).
Returns: Nothing
Errors: grNoInitGraph
PUTS
int cdecl far puts(const char far *str)
Outputs the string str to the termIO window with the focus or to redirected standard output.
Returns: The number of chars output or EOF on error.
void cdecl far rectangle(int left, int top, int right, int bottom);
Draws a rectangle (left,top,right,bottom) in the current color, line style and line thickness.
Returns: Nothing
Errors: grNoInitGraph
_RECTANGLE
short cdecl far _rectangle(short cntrl, short x1, short y1, short x2, short y2);
Draws a rectangle defined by (x1,y1) and (x2,y2). If cntrl is _GFILLINTERIOR, the rectangle is filled in with the current color and fill pattern. If cntrl is _GBORDER, only the outline is drawn.
Returns: TRUE on success, FALSE otherwise
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
REGISTERBGIDRIVER
int cdecl far registerbgidriver(void (far *)(void));
This function performs no service and is present only for code compatibility.
Returns: 1
Errors: None
REGISTERBGIFONT
int cdecl far registerbgifont(void (far *)(void));
This function ignores its argument and returns the number of fonts that Microsoft Windows has available. These fonts can be accessed by number using the Microsoft style _setfont() routine.
short far cdecl _registerfonts(unsigned char far *);
This function ignores its argument and returns the number of fonts that Microsoft Windows has available. These fonts can be accessed by number using the Microsoft style _setfont() routine.
short cdecl far _remapallpalette(long far *color_list);
NOT IMPLEMENTED IN VERSION 2.0!!!!
Applies the color_list of predefined long colors to the palette, changing colors at once on the screen. The colors MUST be from the predefined constants _BLACK, _BLUE, etc. See WinDosIO.h. Colors in other windows might also change, but will be restored when that window receives the focus, the palette is restored or this program terminates.
Returns: 0 if the mapping took place and -1 on error.
Errors: grNoInitGraph
_REMAPPALETTE
long cdecl far _remappalette(short pixel_value, long color);
Redefines the pixel value to the specified color. The change occurs at once on the screen. The color MUST be one of the predefined constants _BLACK, _BLUE, etc. See WinDosIO.h. Colors in other windows might also change, but will be restored when that window receives the focus, the palette is restored or this program terminates.
Returns: The previous color associated with the pixel_value or -1 on error.
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
RESTORECRTMODE
void cdecl far restorecrtmode(void);
Clears the device if there are no errors. In WinDosIO, there is no difference between text and graphics mode.
Returns: Nothing
Errors: grNoInitGraph
SBRK
void far * cdecl far sbrk(int);
This function performs no service and is present only for code compatibility.
Returns: NULL
Errors: None
SCANF
int cdecl far scanf(const char far *formatString,...);
Formats input according to the specification. Gets characters from the keyboard or redirected stdin. See reference for details. All addresses in the format string must be declared as far *, if not using the large or compact memory models.
Returns: The number of input fields scanned, converted and stored. At end of file, the return value is EOF. If no fields are stored, the return value is 0.
Errors: None
SCROLLDOWNWINDOW
void cdecl far scrolldownwindow(int rows, int left, int top, int right,int bottom);
Scrolls the text in the window defined by left, top, right and bottom down by the specified number of rows. Rows left empty at top are filled with the background color.
void cdecl far _scrolltextwindow(short scroll_lines);
Scrolls the text in the current text window by the requested number of lines. A negative number scrolls the window down and a positive value scrolls the window up.
void cdecl far scrollupwindow(int rows, int left, int top, int right,int bottom);
Scrolls the text in the window defined by left, top, right and bottom up by the specified number of rows. Rows left empty at bottom are filled with the background color.
void cdecl far sector(int x, int y, int stangle, int endangle, int xradius, int yradius);
Draws a filled elliptical pie slice with its center at (x,y). It begins at stangle in degrees and ends at endangle in degrees, with a radius in the x direction of xradius and a radius in the y direction of yradius pixels.
Returns: Nothing
Errors: grNoInitGraph
_SELECTPALETTE
short cdecl far _selectpalette(short);
NOT AVAILABLE IN VERSION 2.0
There are 5 available palettes, numbered 0-4. Palettes 0-3 are the four 4-color CGA palettes. Palette 4, is the 16 color EGA/VGA palette.
Returns: The previous palette number or -1 on error.
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
SETACTIVEPAGE
void cdecl far setactivepage(int page);
All subsequent graphics and text output will occur on this page. If the page is not the visible page, current output will not be seen on the screen. All windows are given four pages in memory unless the WDS_NOPAGES flag is set during window creation. In that case, memory for only one page will be allocated.
Returns: Nothing
Errors: grMSParameter
_SETACTIVEPAGE
short cdecl far _setactivepage(short page);
All subsequent graphics and text output will occur on this page. If the page is not the visible page, current output will not be seen on the screen. All windows are given four pages in memory unless the WDS_NOPAGES flag is set during window creation. In that case, memory for only one page will be allocated.
Returns: The previous active page.
Errors: _GRINVALIDPARAMETER
SETALLPALETTE
void cdecl far setallpalette(struct palettetype far *palette);
NOT AVAILABLE IN VERSION 2.0
Changes the palette to the color indices found in palettetype.
Returns: Nothing
Errors: grNoInitGraph
SETASPECTRATIO
void cdecl far setaspectratio(int xasp, int yasp);
This function performs no service and is present only for code compatibility.
Returns: Nothing
Errors: None
SETBKCOLOR
void cdecl far setbkcolor(int color_index);
Sets the background color index specified. Background color changes are reflected at once on screen. Does not affect text background color.
Returns: Nothing
Errors: grNoInitGraph
_SETBKCOLOR
long cdecl far _setbkcolor(long color);
Sets the background color index based on which of the predefined long colors are provided. Background color changes are reflected at once on screen. Text background color is also modified.
Returns: Previous background color.
Errors: _GRINVALIDPARAMETER
SETBLOCK
int cdecl far setblock(unsigned segx, unsigned newsize);
Modifies the size of a block previously allocated with allocmem.
Returns: -1 on error, 0 on success.
Errors: WDE_OUT_OF_MEMORY, WDE_BAD_SEGMENT
_SETCLIPRGN
void cdecl far _setcliprgn(short x1, short y1, short x2, short y2);
Defines an area of the screen as a clipping region for all graphics operations.
Returns: Nothing
Errors: _GRNOTINPROPERMODE
SETCOLOR
void cdecl far setcolor(int color);
This color index is used as the drawing color for all graphics operations.
Returns: Nothing
Errors: grNoInitGraph
_SETCOLOR
short cdecl far _setcolor(short color);
This color index is used as the default color for all drawing AND fill graphics operations.
Returns: 0 or -1 on error.
Errors: _GRNOTINPROPERMODE
_SETCURSORTYPE
void cdecl far _setcursortype(int cur_t);
This function sets the text mode cursor to _NOCURSOR, _SOLIDCURSOR or _NORMALCURSOR. An invalid argument is ignored.
void cdecl far _setfillmask(unsigned char far *fillmask);
Establishes an 8 byte (8 * 8) fillmask to be used as the fill pattern. In a solid fill, all bytes contain 0xff. An empty fill would contain all zeros.
Returns: Nothing
Errors: None
SETFILLPATTERN
void cdecl far setfillpattern(char far *pattern, int color);
Establishes an 8 byte (8 * 8) fillmask to be used as the fill pattern. In a solid fill, all bytes contain 0xff. An empty fill would contain all zeros. 'color' is used as the fill color.
Returns: Nothing
Errors: None
SETFILLSTYLE
void cdecl far setfillstyle(int pattern, int color);
Sets the fill pattern to one of 11 built-in fill patterns. 'color' is used as the fill color.
Returns: Nothing.
Errors: grNoInitGraph, grError
_SETFONT
short far cdecl _setfont(unsigned char far *options);
Parses the option string and determines which font to set. The fonts are chosen from the full set of fonts loaded into Microsoft Windows. Elements in the options string include:
t'name' To request a typeface by name
hn Character height of n pixels
wn Character width of w pixels
v Select only a vector font
r Select only a raster font
b Select a font designed for the device
f Select only a fixed space font
p Select only a proportional font
nx Select font number 'x' from the enumerated list of Windows fonts.
Returns: A non-negative number on success.
Errors: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
SETGRAPHBUFSIZE
unsigned cdecl far setgraphbufsize(unsigned);
This function performs no service and is present only for code compatibility.
Returns: 0
Errors: None
SETGRAPHMODE
void cdecl far setgraphmode(int);
Sets graphics defaults(position, palette, color, etc.) and clears the screen. The argument is ignored.
Returns: Nothing
Errors: grNoInitGraph
_SETGTEXTVECTOR
struct xycoord cdecl far _setgtextvector(short x, short y);
Sets the current orientation for font text output.
(0,0) Ignored
(1,0) Normal horizontal text
(0,1) Rotates text 90 degrees counter-clockwise
(-1,0) Rotates text 180 degrees counter-clockwise
(0,-1) Rotates text 270 degrees counter-clockwise
Rotation other than normal, only works with vectored fonts. All argument values are normalized to 1 or -1.
void cdecl far setlinestyle(int linestyle, unsigned upattern, int thickness);
The style of line can be set as follows: SOLID_LINE, DOTTED_LINE, CENTER_LINE, DASHED_LINE, DASHDOT_LINE, DASHDOTDOT_LINE. This is more extensive than the Borland function. USERBIT_LINE can be specified, but its meaning is more limited. The upattern is taken mod 7 to determine the built-in line pattern. The upattern is divided by 8 and 1 is added to determine the line thickness in pixels. This is of limited use, as any line thickness in pixels can be specified in the thickness parameter.
Returns: Nothing
Errors: grNoInitGraph,grError
_SETLINESTYLE
void cdecl far _setlinestyle(unsigned short upattern);
The upattern is taken mod 7 to determine the built-in line pattern(See setlinestyle() above). The upattern is divided by 8 and 1 is added to determine the line thickness in pixels. This function is more limited than the Microsoft function.
Returns: Nothing
Errors: None
_SETLOGORG
struct xycoord cdecl far _setlogorg(short x, short y);
Sets the origin of the logical coordinate system to point (x,y).
Returns: 4 byte structure with the previous logical origin.
Errors: _GRNOTINPROPERMODE
SETPALETTE
void cdecl far setpalette(int colornum, int color);
Changes the colornum entry in the palette to the color specified. The change occurs on the screen at once.
Returns: Nothing
Errors: grNoInitGraph
_SETPIXEL
short cdecl far _setpixel(short x, short y);
Sets the pixel at window coordinates (x,y) to the current color.
Returns: The color of the previous pixel at (x,y)
Errors: None
_SETTEXTCOLOR
short cdecl far _settextcolor(short attribute);
Sets the text color of all text output with non-graphics mode text functions to the specified attribute.
Returns: The previous text color.
Errors: None
_SETTEXTCURSOR
short cdecl far _settextcursor(short attr);
Sets the text cursor in a limited fashion. SEE CODE
Returns: The previous cursor attribute.
Errors: _GRNOTINPROPERMODE
SETTEXTJUSTIFY
void cdecl far settextjustify(int horiz, int vert);
Text output from outtext() and outtextxy() is justified around the current position as specified. Horizontal values are LEFT_TEXT, RIGHT_TEXT and CENTER_TEXT. Vertical values are BOTTOM_TEXT, CENTER_TEXT(which aligns to the baseline) and TOP_TEXT.
Returns: Nothing
Errors: grError
_SETTEXTPOSITION
struct rccoord far cdecl _settextposition(short row, short col);
Sets the current text position to the specified row and column in both text and graphics modes.
Returns: The previous text position.
Errors: None
_SETTEXTROWS
short cdecl far _settextrows(short rows);
Specifies the number of text rows up to 43.
Returns: The number of rows actually set or 0 in case of error.
Errors: _GRINVALIDPARAMETER
SETTEXTSTYLE
void cdecl far settextstyle(int font, int direction, int charsize);
Sets the current font . Fonts 0 through 4 are Borland defined fonts. Fonts starting at 100 are the enumerated fonts available through windows. Use _setfont for more control over font selection. The direction is either HORIZ_DIR for left to right or VERT_DIR for bottom to top. charsize is a multiple of an 8x8 pixel rectangle. When charsize is zero, the default is a charsize of 4, or the value set by setusercharsize().
Returns: Nothing
Errors: None
_SETTEXTWINDOW
void cdecl far _settextwindow(short r1, short c1, short r2, short c2);
Defines a text window in terms of row and column coordinates. Once defined, all row and column references are relative to the defined window.
Returns: Nothing
Errors: None
SETUSERCHARSIZE
void cdecl far setusercharsize(int multx, int divx, int multy, int divy);
Gives extra control over the size of fonts used with graphics functions. The x and y fractions are applied to the default charactersize when a charsize of 0 is used in the settextstyle() function.
Returns: Nothing
_SETVIDEOMODE
short cdecl far _setvideomode(short mode);
Switches between text and graphics modes. Both 40 and 80 character text modes are functional. All graphics modes behave the same.
Returns: TRUE on success, FALSE otherwise
Errors: _GRMODENOTSUPPORTED,_GRINVALIDPARAMETER
_SETVIDEOMODEROWS
short cdecl far _setvideomoderows(short mode, short rows);
Sets the videomode and textrows at the same time. See _setvideomode and _settextrows.
Returns: The number of rows actually set, or 0 on error.
Errors: _GRMODENOTSUPPORTED,_GRINVALIDPARAMETER
_SETVIEWORG
struct xycoord cdecl far _setvieworg(short x, short y);
Sets the origin of the logical coordinate system to point (x,y).
Returns: The physical coordinates of the previous view origin.
Errors: _GRNOTINPROPERMODE
SETVIEWPORT
void cdecl far setviewport(int top, int left, int right, int bottom, int clip);
Sets the current viewport for graphics output and sets the current position to (0,0). If clip is non-zero, all drawings will be clipped to the current viewport.
Returns: Nothing
_SETVIEWPORT
void cdecl far _setviewport(short x1, short y1, short x2, short y2);
Sets the current viewport for graphics output to the specified rectangle. Clipping will occur at the rectangle boundary.
Returns: Nothing
Errors: _GRNOTINPROPERMODE
SETVISUALPAGE
void cdecl far setvisualpage(int page);
Makes page 0 through 3 the current text and graphics page displayed on the screen.
Returns: Nothing
_SETVISUALPAGE
short cdecl far _setvisualpage(short);
Makes page 0 through 3 the current text and graphics page displayed on the screen.
Returns: Returns the page number of the previous visual page or a negative number on error.
Errors: _GRINVALIDPARAMETER
SETWRITEMODE
void cdecl far setwritemode(int mode);
Determines the write mode (color combination mode) of drawing lines on a background. Values are COPY_PUT, XOR_PUT, NOT_PUT, AND_PUT and OR_PUT.
Returns: Nothing
_SETWRITEMODE
short cdecl far _setwritemode(short action);
Determines the write mode(color combination mode) of drawing lines on a background. Values are _GPSET, _GXOR, _GPRESET, _GAND, _GOR.
Returns: The previous write mode or -1 on error.
Returns: _GRNOTINPROPERMODE, _GRINVALIDPARAMETER
SLEEP
void cdecl far sleep(unsigned seconds);
Returns to Windows for at least the specified number of seconds. If another application gains control, the delay could be longer.
Returns: Nothing
SOUND
void cdecl far sound(unsigned frequency);
Turns on the speaker at the specified frequency. To turn it off, call nosound, usually with an intervening delay or sleep.
Returns: Nothing
TEXTATTR
void cdecl far textattr(int newattr)
Sets the foreground and background attribute of the termIO window with the focus. All subsequent printing will be done using this attribute until the attribute is changed with textattr, textcolor or textbackground. Color mnemonics are defined in WinDosIO.h.
Sets the background attribute of the termIO window with the focus. All subsequent printing will be done using this attribute until the attribute is changed with textattr or textbackground. Color mnemonics are defined in WinDosIO.h.
Sets the foreground attribute of the termIO window with the focus. All subsequent printing will be done using this attribute until the attribute is changed with textattr or textcolor. Color mnemonics are defined in WinDosIO.h.
Returns the height of the textstring in the current font. This is the height which should be used in calculations, not the height requested in the _setfont or settextstyle functions.
Returns: The text height in pixels.
TEXTMODE
void cdecl far textmode(int newmode);
Places the screen in either 40 character or 80 character text mode. Valid modes are LASTMODE, BW40, C40, BW80, C80, MONO and C4350 although currently there are only two possible outcomes, 40 character color or 80 character color.
Returns: Nothing
TEXTWIDTH
int cdecl far textwidth(char far *textstring);
Returns the width of the textstring in the current font. This is the width that should be used in calculations, not the width requested in the _setfont or settextstyle functions.
Returns: The text width in pixels.
UNGETCH
int cdecl far ungetch(int ch)
Pushes back the last character read with getch or getche. This character will be read on the next call to getch or getche. Only the last character returned is read back.
This function provides no service and is present only for code compatibility.
Returns: Nothing
Errors: None
VPRINTF
int cdecl far vprintf(const char far *formatString,const void far *pArguments)
Displays the resultant formatted string in the termIO window with the focus or to redirected standard output. See one of the many C texts available for a description of the control codes allowed. The second argument is a pointer to a list of arguments for the formatString. Any pointers in the argument list should have been cast or declared as far *, if not compiling with the large or compact memory models.
Returns: The number of characters output or EOF on error
int cdecl far vscanf(const char far *formatString,const void far *pArguments);
Formats input according to the specification. Gets characters from the keyboard or redirected stdin. See reference for details. The second argument is a pointer to the list of arguments for formatString. All pointers in the list should be declared as far *, if not compiling with the large or compact memory models.
Returns: The number of input fields scanned, converted and stored. At end of file, the return value is EOF. If no fields are stored, the return value is 0.
Errors: None
WHEREX
int cdecl far wherex(void);
Within the current text window, returns cursor x-coordinate.
Returns: The column of the current text cursor position.
WHEREY
int cdecl far wherey(void);
Within the current text window, returns cursor y-coordinate.
Returns: The row of the current text cursor position.
WINDOW
void cdecl far window(int left, int top, int right, int bottom);
Defines the current text window at left, top, right and bottom.
Returns: Nothing
_WRAPON
short cdecl far _wrapon(short flag);
Determines whether text is clipped or wraps to the next line when text is output beyond the bounds of the text window. Values are _GWRAPOFF and _GWRAPON.
Returns: The previous state of wrapping.
Other Functions Supported
Prototypes in WinDosIO.h
RETURN TO APPLICATION
void cdecl far ReturnToApplication(int retCode)
Causes execution to resume with a return from the last call to ReturnToWindows(), as soon as Windows regains control. If there was no previous call to ReturnToWindows, the call has no effect. RetCode becomes the return value for ReturnToWindows.
Returns: Nothing.
Errors: None
RETURN TO WINDOWS
int cdecl far ReturnToWindows(void)
Invokes normal windows message processing. This subroutine does not return until ReturnToApplication(retCode) is subsequently called. At that time, the argument to ReturnToApplication, is the return code from ReturnToWindows.
Returns: Argument from ReturnToApplication or WDE_USERQUIT (-3).
Errors: None
WINDOSIO
int pascal far WinDosIO(short type, unsigned short wParam, unsigned long lParam)
This is an application interface to the WinDosIO library. The type field determines the nature of the call, the arguments and the return.WDE_ error messages are returned directly and not stored inWDErrno. Types and arguments are discussed below.
Returns: Varies with type field.
Errors: Varies with type field.
WINDOSIO TYPES(first argument to WinDosIO)
WD_DESTROY
Example: WinDosIO(WD_DESTROY,hInstance,0);
This function must be called from the WM_CLOSE handler in the main window procedure, to insure proper surrender of all resources to Windows. It can optionally be called as the last line of the program, if the window should not persist until the user clicks on the close icon.
Returns: Nothing
WD_GETERRNO
Example: WinDosIO(WD_GETERRNO,0,0);
This function returns the last value of WDErrno as set by the WinDosIO C functions. This value will be overwritten anytime a WinDosIO C function is called.
Returns: WDErrno (For values, see below)
WD_INIT
Example: WinDosIO(WD_INIT,hInstance,0);
This function must be called prior to using the WinDosIO library. Functions will set WDErrno to WDE_UNINITIALIZED if this function has not been called. It is called with the instance handle of the application. If WinDosIO.c is compiled and linked with the application, this function is called automatically.
Returns: Nothing
WD_SELECT
Example: WinDosIO(WD_SELECT,hwndTermIO,0);
This function selects the termIO window whose handle (returned, for instance, from CreateWindow) is specified , to have both the input and output focus.
Returns the device context used internally by the termIO window to insure persistent output. With this device context and the screen device context obtained from the window handle, applications can use any Windows functions to write to the termIO window.
Returns: The handle to the termIO windows device context.
This function registers a main (not a termIO) window for the application. If you register your own main window, you must also write at least a minimal window procedure to be compatible with WinDosIO. If you compile and link with WinDosIO.c, this function will be called automatically.
This function creates a termIO window with the left, top, right and bottom specified in the CWS structure. You can create your own termIO window with Windows CreateWindow. If you compile and link with WinDosIO.c, your first termIO window is created automatically for you to the largest size that will fit within the main window.
Create the main window previously registered with WD_REGISTER_WINDOW. If you use CreateWindow to create the main window , create a window of the class WinDosIO, unless you also used Window's RegisterWindow to register the main window, in which case at least the minimal window proc is required.
Sets the title of the current termIO window to the specified string.
WD_DEFERPAINT
Example: WinDosIO(WD_DEFERPAINT,TRUE,0);
Defers painting to the screen device context until painting is turned back on with a call to the same function with FALSE as the second argument. At that time, the entire screen is painted from the internal device context.
WINDOSIO ERRORS
The following errors are supported in version 2.0. They are either returned directly or returned from WinDosIO(WD_GETERRNO,0,0), depending on function.
Mnemonic Value
WDE_UNINITIALIZED -1
WinDosIO(WD_INIT,0,0) was not called earlier or failed.
WDE_NO_CURRENT_WINDOW -2
The current termIO window was destroyed and a new window was not selected.
WDE_USERQUIT -3
The window has been closed, termIO windows are no longer functional.
WDE_TOO_MANY_WINDOWS -4
Only 128 termIO windows are allowed at a time.
WDE_HANDLE_OUT_OF_RANGE -5
Invalid handle when selecting a termIO window.
WDE_DISK_ERROR -6
Problem with redirected IO.
WDE_ALREADY_UNGOT -7
ungetch() can only be called once between reads.
WDE_OUT_OF_MEMORY -8
There is no more memory available.
WDE_UNKNOWN_WDCODE -10
WinDosIO is called with an unknown type.
WDE_NO_MORE_APPLICATIONS -11
Only 32 applications can use the WinDosIO library at a time.
WDE_BAD_MODE -12
A WinDosIO function was called with an invalid parameter.
WDE_BAD_X -13
A WinDosIO function was called with an illegal x coordinate or column.
WDE_BAD_Y -14
A WinDOsIO function was called with an illegal y coordinate or row.
TERMIO STYLES
Styles are or'd in with WS_ window styles in such calls as CreateWindow.
Mneumonic Value
WDS_SELECT 1L
This style allows a termIO window to gain the input and output focus if clicked on with the left button of the mouse.
WDS_NOSCROLL 2L
Prevents the window from scrolling when writing beyond the bottom line.
WDS_NOPAGES 4L
If multiple pages are not going to be used in the display, this style allocates less memory and speeds up processing slightly.
WDS_NOTEXTBUFFER 8L
If the gettext(), puttext() and movetext() functions are not going to be used, all text can be stored wholly as graphics, speeding up text display by about 20%.
NOTIFICATION MESSAGES
These are messages sent from the termIO window to its parent window. As in standard notification messages, the wParam contains the termIO windows ID, the notification code is in the HIWORD of lParam and the handle of the termIO window is in the LOWORD of lParam.
Mnemonic Value
WDN_SETFOCUS 1
Sent when the termIO window receives the input/output focus.
WDN_KILLFOCUS 2
Sent when the termIO window loses the input/output focus.
WDN_LBUTTON 3
Sent when the left button of the mouse is clicked over the termIO window.
WDN_RBUTTON 4
Sent when the right button of the mouse is clicked over the termIO window.
